Skip to content

SLS-1543: Add script to automatically create PR against documentation #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

IvanTopolcic
Copy link
Contributor

@IvanTopolcic IvanTopolcic commented Oct 5, 2021

What does this PR do?

This PR automatically adds a step at the end of deploying layers that creates a PR against the documentation with the updated version variable.

This PR clones the documentation repo to $DATADOG_ROOT/documentation if it doesn't exist, creates a new branch, makes the changes to bump the version, opens a tab to create a PR. If the documentation repo is not clean (there are local changes), then the script will fail and ask the user to continue and manually create the PR.

Motivation

Reduce friction for deploying new lambda layers.

Testing Guidelines

Changes were tested locally via the deploy sandbox lambda script.

Additional Notes

Types of Changes

  • Bug fix
  • New feature
  • Breaking change
  • Misc (docs, refactoring, dependency upgrade, etc.)

Check all that apply

  • This PR's description is comprehensive
  • This PR contains breaking changes that are documented in the description
  • This PR introduces new APIs or parameters that are documented and unlikely to change in the foreseeable future
  • This PR impacts documentation, and it has been updated (or a ticket has been logged)
  • This PR's changes are covered by the automated tests
  • This PR collects user input/sensitive content into Datadog
  • This PR passes the integration tests (ask a Datadog member to run the tests)

@IvanTopolcic IvanTopolcic requested a review from a team as a code owner October 5, 2021 18:11
@codecov-commenter
Copy link

codecov-commenter commented Oct 5, 2021

Codecov Report

Merging #231 (4e85929) into main (7fca5df) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #231   +/-   ##
=======================================
  Coverage   87.89%   87.89%           
=======================================
  Files          32       32           
  Lines        1231     1231           
  Branches      249      249           
=======================================
  Hits         1082     1082           
  Misses         88       88           
  Partials       61       61           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7fca5df...4e85929. Read the comment docs.

Copy link
Contributor

@maxday maxday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ! 🎉

@IvanTopolcic IvanTopolcic merged commit 57f8e9c into main Oct 6, 2021
@IvanTopolcic IvanTopolcic deleted the ivan.topolcic/automatically-create-documentation-pr branch October 6, 2021 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants